5001: Subscribe Existing Person and Contact to Mailinglist

Properties

Required

Subscription: Michael Miller to operations-announce from 5000: Subscribe New Person and Contact to Mailinglist

Given

name	value
partnerPersonTradeName	Test AG
subscriberFamilyName	Miller
subscriberGivenName	Michael
subscriberEMailAddress	michael.miller@example.org
mailingList	operations-discussion

Person: Test AG

HTTP GET "/api/hs/office/persons?name=Test+AG" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "3029ef4b-ab91-429d-855b-26a8bedcef6e", // Person: Test AG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Test AG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

Person: Michael Miller

HTTP GET "/api/hs/office/persons?name=Miller" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "4023f949-de5c-4708-b1fa-fddbfacab1c7",
  "personType" : "NATURAL_PERSON",
  "tradeName" : null,
  "salutation" : null,
  "title" : null,
  "givenName" : "Michael",
  "familyName" : "Miller"
} ]

In real scenarios there are most likely multiple results and you have to choose the right one.

Contact: michael.miller@example.org

HTTP GET "/api/hs/office/contacts?emailAddress=michael.miller@example.org" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "a333a58f-f2ce-454b-9d86-b26d31f7d700",
  "caption" : "Michael Miller",
  "postalAddress" : { },
  "emailAddresses" : {
    "main" : "michael.miller@example.org"
  },
  "phoneNumbers" : { }
} ]

In real scenarios there are most likely multiple results and you have to choose the right one.

HTTP POST "/api/hs/office/relations" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-discussion",
  "anchor.uuid" : "3029ef4b-ab91-429d-855b-26a8bedcef6e", // Person: Test AG
  "holder.uuid" : "4023f949-de5c-4708-b1fa-fddbfacab1c7", // Person: Michael Miller
  "contact.uuid" : "a333a58f-f2ce-454b-9d86-b26d31f7d700" // Contact: michael.miller@example.org
}
EOF
=> status: 201 CREATED 8d0c6f01-8944-45c1-a3ca-3afab499b098

generated on 2026-08-10 03:08:33 for branch HEAD

Scenario #5001: Subscribe Existing Person and Contact to Mailinglist